Skip to content

Develop#6

Merged
x42en merged 9 commits intomasterfrom
develop
Mar 18, 2026
Merged

Develop#6
x42en merged 9 commits intomasterfrom
develop

Conversation

@x42en
Copy link
Contributor

@x42en x42en commented Mar 18, 2026

This pull request introduces significant improvements to project infrastructure, automation, and documentation. It adds comprehensive GitHub Actions workflows for testing, releasing, and documentation deployment, provides a detailed contributing guide, modernizes the Docker build process, and updates licensing information. These changes streamline CI/CD, clarify contribution standards, and improve maintainability.

Continuous Integration and Deployment:

  • Introduced .github/workflows/test.yml for automated testing and coverage reporting on pull requests and non-main branch pushes, supporting multiple Python versions and uploading coverage to Codecov.
  • Added .github/workflows/release.yml to automate testing, linting, and Docker image building/publishing on releases, including multi-registry support for Docker Hub and GitHub Container Registry.
  • Created .github/workflows/pages.yml to automatically build and deploy documentation to GitHub Pages using MkDocs, including steps to generate default documentation files if missing.

Documentation and Contribution Guidelines:

  • Added a detailed CONTRIBUTING.md outlining code standards, development setup, testing practices, naming conventions, and PR process to help onboard new contributors and maintain code quality.

Build and Packaging:

  • Added a modern Dockerfile leveraging Python 3.11, Poetry for dependency management, and exposing the default service port, improving reproducibility and deployment.
  • Removed legacy Pipfile in favor of Poetry, reflecting a shift to more robust dependency management.

Licensing:

  • Updated the LICENSE to reflect new copyright ownership under CIRCLE cyber.

@x42en x42en self-assigned this Mar 18, 2026
@x42en x42en added bug Something isn't working enhancement New feature or request labels Mar 18, 2026
@x42en x42en merged commit 0bc6c65 into master Mar 18, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant